home *** CD-ROM | disk | FTP | other *** search
/ Amiga Games: Greatest Hits 1996 / Amiga Games: Greatest Hits 1996.iso / archive / userbox / publicdomain / frexxed.lha / frexxed / bin / FPLdb.doc < prev    next >
Text File  |  1995-02-08  |  2KB  |  75 lines
  1.                          FPLdb - FPL debugging tool
  2.                          ~~~~~~~~~~~~~~~~~~~~~~~~~~
  3. LEGAL STUFF
  4. ~~~~~~~~~~~
  5.  FPLdb is free software; you may redistribute for non commercial purposes
  6. only. FPLdb is actually a part of the FPL developer archive. 
  7.  
  8.  FPLdb is written with the intent of being a fully working program,
  9. but there are no guarantees at all, only that it occupies disk space and
  10. acutally has been working for me more than once. The author of this program
  11. takes no responsibility at all if it proves defective in any way.
  12.  
  13. USAGE
  14. ~~~~~
  15. FPLdb [W=Window/k] [H=Help/s]
  16.  
  17.   Window - Specify a window string to use. Default is
  18.            "CON:0/0/640/200/FPLdb/AUTO/CLOSE/WAIT/INACTIVE", but I can warmly
  19.            recommend the use of KingCON and a window string similar to:
  20.            "KCON:0/0/560/200/FPL debug output/MINI"
  21.  
  22.   Help   - Displays a very short description text.
  23.  
  24. DESCRIPTION
  25. ~~~~~~~~~~~
  26.  FPLdb is a small and still not very developed little tool to improve FPL
  27. debugging. It displays a window, in which trace information about running
  28. FPL programs can be shown.
  29.  
  30.  All FPL programs in the system that are run in debug-mode will get the
  31. current executed line-number and position written to the window. This sounds
  32. much more complicated than it is.
  33.  
  34. DEBUG-MODE
  35. ~~~~~~~~~~
  36.  Debug-mode means all programs in this and lower levels that run after
  37. 'debug(1);' has been used. When the program that called debug(1) ends, the
  38. debug-mode is switched off again.
  39.  Default debug-mode can be switched on by altering the global info variable
  40. in FrexxEd called 'fpl_debug'. By setting that to 1, all programs started
  41. in FrexxEd will start in debug-mode and thus cause debug output.
  42.  
  43. EXIT
  44. ~~~~
  45. Quit FPLdb by sending CTRL-C to it and then close the window.
  46.  
  47. EXAMPLE
  48. ~~~~~~~
  49.  To have a look how FPL interprets the loop written like:
  50.  
  51.    int a;
  52.    for(a=0; a<10; a++)
  53.      a++;
  54.  
  55.  we start the execution by calling the debug-function with 'debug(1);' like:
  56.  
  57.    int a;
  58.    debug(1);
  59.    for(a=0; a<10; a++)
  60.      a++;
  61.  
  62.  (we could also have done it by simply switched on 'fpl_debug' before the
  63.  execution)
  64.  FPLdb will then write some text in its window that looks similar to:
  65.  
  66.    2 :int a;
  67.    3 :for(a=0; a<10; a++)
  68.    4 :a++;
  69.    4 :a++;
  70.    4 :a++;
  71.    4 :a++;
  72.    4 :a++;
  73.  
  74.  which then of course shows the interpret-trace of the program.
  75.